Skip to main content

Webhooks Payloads - Media Actions

VIDIZMO's Webhooks enable you to subscribe to the various events taking place within the VIDIZMO portal and receive notifications based on those events within your business application.

To read more about what Webhooks are and how to set them up, see: VIDIZMO Webhooks Reference Guide.

In this document, you will find a few samples of JSON Request Body of events that can be subscribed to in VIDIZMO.

Before you start​

  • In order to understand the various events associated with media being updated in the portal, see: Webhooks Payloads - Media Updated.
  • In the request body samples below, mashupInfo Object sent in the event payload is the same for every event with the exception of a few properties that may be irrelevant to the event under question. This is why it has been excluded from the samples with an inclusion of only relevant properties that shall help you determine what changed. To study the object and its properties in detail, see: API Reference Guide - MashupInfo Object.

Media Viewed​

Find below the event log object included in the request body of the notification payload sent when media is viewed.

{
    "id": "66278",
    "eventDate": "2020-10-26T06:23:30.437",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263482,
    "subjectTitle": "Annual Conference Summit 2019",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "MashupViewed",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Media Added to My Favorites​

Find below the event log object included in the request body of the notification payload sent when media is favorited.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:48:33.017",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263483,
    "subjectTitle": "Collaboration Mapping 2019",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "AddMashupToMyFavorite",
    "subjectDetail": "\"\"",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Media Removed from My Favorites​

Find below the event log object included in the request body of the notification payload sent when media is unfavorited.

{
    "id": "66728",
    "eventDate": "2020-10-28T19:35:38.937",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "None",
    "subjectId": 263482,
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "DeleteMashupFromMyFavorite",
    "subjectDetail": "\"\"",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Media Clipped​

Find below the event log object included in the request body of the notification payload sent when media is clipped. Here, complete mashupInfo object is included in subjectDetails, more details of which can be read from: API Reference Guide - MashupInfo Object.

{
    "id": "66728",
    "eventDate": "2020-08-27T14:22:44.013",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 422,
    "subjectTitle": "AC20-M03-GER-SWE-67-HB",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "MashupClipped",
    "description": "Publish",
    //Updated mashup Object will be included here after clipping
    // Read more about it here: API Reference Guide - MashupInfo Object
    "subjectDetail": "{...}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Media Liked​

Find below the event log object included in the request body of the notification payload sent when media is liked.

{
    "id": "66728",
    "eventDate": "2020-10-26T06:13:57.647",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263487,
    "subjectTitle": "Linaro CEO George Grey",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "RatingAdd",
    "subjectDetail": "{\"Value\":1,\"Type\":\"LikeDislike\",\"Subject\":\"Video\",\"ObjectId\":263487,\"TenantId\":18761,\"UserProfileId\":218003}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Media Unliked​

Find below the event log object included in the request body of the notification payload sent when media is unliked.

{
    "id": "66728",
    "eventDate": "2020-10-26T06:14:08.323",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263487,
    "subjectTitle": "Linaro CEO George Grey",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "RatingDelete",
    "subjectDetail": "\"\"",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Media Shared via Mail​

Find below the event log object included in the request body of the notification payload sent when media is shared via mail.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:48:25.987",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263483,
    "subjectTitle": "Collaboration Mapping 2019",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "ReferToFriend",
    "subjectDetail": "{\"FriendEmailAddresses\":[\"esther.fray@vidizmo.com\"],\"MashupId\":263483,\"SenderUserProfileId\":218003}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Feedback Provided on Media​

Find below the event log object included in the request body of the notification payload sent when media is provided feedback on.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:48:00.74",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263483,
    "subjectTitle": "Collaboration Mapping 2019",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "FeedbackImprovement",
    "description": "This tutorial video needs to be more explanatory, a lot of details are missing. Kindly look into it.",
    "subjectDetail": "{\"Id\":1504,\"ReportById\":218003,\"Name\":\"Esther Fray\",\"FeedbackTypeId\":\"SuggestAnImprovement\",\"EmailAddress\":\"esther.fray@sharklasers.com\",\"MashupInfo\":{\"Id\":0,\"EstimatedDuration\":0,\"Weight\":0,\"Format\":\"All\",\"IsMyFlaggedMashup\":false},\"TenantId\":18761,\"Comments\":\"This tutorial video needs to be more explanatory, a lot of details are missing. Kindly look into it.\",\"AddedDateTime\":\"0001-01-01T00:00:00\",\"ObjectId\":263483,\"ObjectTypeId\":1}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Access Rights Added​

Find below the event log object included in the request body of the notification payload sent when media access license is assigned.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:46:20.797",
    "ip": "136.135.169.234",
    "status": "None",
    "subjectType": "Video",
    "subjectId": 263483,
    "subjectTitle": "Collaboration Mapping 2019",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "AccessRightsAdded",
    "subjectDetail": "{\"Id\":0,\"Mashup\":{\"Id\":263483,\"Tenant\":{\"Id\":18761,\"IsSSLEnable\":false,\"Weight\":0},\"EstimatedDuration\":0,\"Weight\":0,\"Format\":\"All\",\"IsMyFlaggedMashup\":false},\"MaxAllowedViews\":20,\"FromDate\":\"2020-10-26T05:41:51Z\",\"EndDate\":\"2020-10-31T05:41:51Z\",\"Tenant\":{\"Id\":18761,\"IsSSLEnable\":false,\"Weight\":0},\"IsDeleted\":false,\"LicenseStatus\":\"Active\",\"AddedDateTime\":\"0001-01-01T00:00:00\",\"AddedBy\":{\"Id\":218003},\"UpdatedBy\":{\"Id\":218003},\"UserAccessRight\":[{\"Id\":0,\"LicenseId\":0,\"UserProfile\":{\"Id\":218204},\"AddedDateTime\":\"0001-01-01T00:00:00\",\"ActionId\":0,\"Consumed\":false,\"IsDeleted\":false}],\"NoOfConsumedLicenses\":0,\"NumberOfUsers\":1,\"AccessRightType\":\"UsersGroups\",\"LimitedDuration\":true,\"Permission\":128,\"DRMDefault\":false}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
  }

Access Rights Updated​

Find below the event log object included in the request body of the notification payload sent when media access license is updated.

{
      "id": "66728",
      "eventDate": "2020-09-03T09:22:19.77",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Playlist",
      "subjectId": 406,
      "subjectTitle": "HB selection",
      "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
      "vidizmoEventId": "AccessRightsUpdated",
      "description": "UpdateAccessRights",
      "subjectDetail": "{\"Id\":22,\"Mashup\":{\"Id\":406,\"Tenant\":{\"Id\":2,\"IsSSLEnable\":false,\"Weight\":0},\"EstimatedDuration\":0,\"Weight\":0,\"Format\":\"All\"},\"MaxAllowedViews\":0,\"Tenant\":{\"Id\":2,\"IsSSLEnable\":false,\"Weight\":0},\"IsDeleted\":false,\"LicenseStatus\":\"Active\",\"AddedDateTime\":\"2020-09-03T09:06:51.883\",\"AddedBy\":{\"Id\":5},\"UpdatedBy\":{\"Id\":5},\"UpdatedDateTime\":\"2020-09-03T09:08:01.603\",\"UserAccessRight\":[{\"Id\":51,\"LicenseId\":22,\"UserProfile\":{\"FirstName\":\"Esther\",\"LastName\":\"Fray\",\"EmailAddress\":\"esther.fray@International.org\",\"Id\":4},\"AddedDateTime\":\"2020-09-03T09:06:51.917\",\"UpdatedDateTime\":\"2020-09-03T09:08:01.607\",\"ActionId\":0,\"Consumed\":false,\"IsDeleted\":false,\"AddedBy\":{\"Id\":5},\"UpdatedBy\":{\"Id\":5}}],\"NoOfConsumedLicenses\":0,\"NumberOfUsers\":1,\"AccessRightType\":\"External\",\"LimitedDuration\":false,\"Permission\":0,\"DRMDefault\":false}",
      "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
      "isSystem": false,
    }

Access Rights Deleted​

Find below the event log object included in the request body of the notification payload sent when media access license is deleted.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:47:17.77",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263483,
    "subjectTitle": "Collaboration Mapping 2019",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "AccessRightsDeleted",
    "description": "",
    "subjectDetail": "{\"Id\":44129,\"Mashup\":{\"Id\":263483,\"EstimatedDuration\":0,\"Weight\":0,\"Format\":\"All\",\"IsMyFlaggedMashup\":false},\"MaxAllowedViews\":20,\"FromDate\":\"2020-10-26T05:41:51\",\"EndDate\":\"2020-10-31T05:41:51\",\"Tenant\":{\"Id\":18761,\"IsSSLEnable\":false,\"Weight\":0},\"IsDeleted\":false,\"LicenseStatus\":\"Active\",\"AddedDateTime\":\"2020-10-26T05:46:18.763\",\"AddedBy\":{\"FirstName\":\"Esther\",\"LastName\":\"Fray\",\"EmailAddress\":\"esther.fray@sharklasers.com\",\"AddedById\":217993,\"AddedDateTime\":\"2020-09-01T07:42:31.27\",\"UpdatedDateTime\":\"2020-09-01T11:35:36.533\",\"LastLogOn\":\"2020-10-26T04:40:59.91\",\"Id\":218003,\"DefaultTenantId\":18639,\"ConfirmationDateTime\":\"2020-09-01T07:52:46.963\"},\"UpdatedBy\":{\"FirstName\":\"Esther\",\"LastName\":\"Fray\",\"EmailAddress\":\"esther.fray@sharklasers.com\",\"AddedById\":217993,\"AddedDateTime\":\"2020-09-01T07:42:31.27\",\"UpdatedDateTime\":\"2020-09-01T11:35:36.533\",\"LastLogOn\":\"2020-10-26T04:40:59.91\",\"Id\":218003,\"DefaultTenantId\":18639,\"ConfirmationDateTime\":\"2020-09-01T07:52:46.963\"},\"UserAccessRight\":[{\"Id\":133493,\"LicenseId\":44129,\"UserProfile\":{\"FirstName\":\"Molly\",\"LastName\":\"Mathews\",\"EmailAddress\":\"molly@sharklasers.com\",\"Id\":218204},\"AddedDateTime\":\"2020-10-26T05:46:19.863\",\"ActionId\":0,\"Consumed\":false,\"IsDeleted\":false,\"AddedBy\":{\"Id\":218003}}],\"NoOfConsumedLicenses\":0,\"NumberOfUsers\":1,\"AccessRightType\":\"UsersGroups\",\"LimitedDuration\":true,\"Permission\":128,\"DRMDefault\":false}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Media Deleted​

Find below the event log object included in the request body of the notification payload sent when media is deleted.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:33:59.25",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263484,
    "subjectTitle": "Corporate Philanthropy Summit",
    "tenant": {...
    }, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "MashupDeleted",
    "user": {...
    }, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Media Restored​

Find below the event log object included in the request body of the notification payload sent when media is restored from Recycle Bin after deletion.

{
    "eventDate": "2020-10-26T05:34:33.263",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263484,
    "subjectTitle": "Corporate Philanthropy Summit",
    "tenant": {...
    }, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "MashupRestored",
    "user": {...
    }, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
}

Media Copied​

Find below the event log object included in the request body of the notification payload sent when media is copied.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:32:58.533",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263491,
    "subjectTitle": "Collaboration Mapping 2019",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "MashupCopied",
    "description": "Collaboration Mapping 2019",
    //Complete mashup Object will be included here
    // Read more about it here: API Reference Guide - MashupInfo Object
    "subjectDetail": "{...}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
  }

Media Published​

Find below the event log object included in the request body of the notification payload sent when media is published.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:32:56.563",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263491,
    "subjectTitle": "Collaboration Mapping 2019",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "MashupPublished",
    //Complete mashup Object will be included here
    // Read more about it here: API Reference Guide - MashupInfo Object
    "subjectDetail": "{...}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
  }

Media Downloaded​

Find below the event log object included in the request body of the notification payload sent when media is downloaded.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:24:18.613",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263481,
    "subjectTitle": "ACN Webinar Training 2019",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "MashupDownloaded",
    "description": "",
    "subjectDetail": "{\"url\":\"https://yourportalurl.com/cdn/18761/acn/acnwebinartraining2019mp4/a54b16ca224247ec936b96124e57677d_256k_426x240.mp4\",\"quality\":\"240p\"}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
  }

Media Reuploaded​

Find below the event log object included in the request body of the notification payload sent when media is reuploaded.

{
    "id": "66278",
    "eventDate": "2020-10-26T05:24:08.967",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "Video",
    "subjectId": 263484,
    "subjectTitle": "Corporate Philanthropy Summit",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "MashupReupload",
    //Updated mashup Object will be included here
    // Read more about it here: API Reference Guide - MashupInfo Object
    "subjectDetail": "{...}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
  }

Default Publish Settings Changed​

Find below the event log object included in the request body of the notification payload sent when media's default publish settings are changed.

{
    "id": "66278",
    "eventDate": "2020-10-26T04:51:16.247",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "PublishAndViewSetting",
    "subjectId": 155967,
    "subjectTitle": "Video",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "DefaultPublishSettingSaved",
    "subjectDetail": "{\"Id\":155967,\"TenantId\":18761,\"MashupFormat\":\"Video\",\"DefaultPublishSettings\":{\"Id\":0,\"EstimatedDuration\":0,\"Version\":0,\"IsFeatured\":true,\"ShowOnChannelLibrary\":true,\"Weight\":0,\"Format\":\"All\",\"IsTranscriptionEnabled\":false,\"Participation\":{\"CommentEnabled\":false,\"CommentModerationRequired\":false,\"IsMashupStatsEnabled\":false,\"IsDownload\":true,\"IsEmbed\":true,\"IsSocialSharing\":true},\"IsMyFlaggedMashup\":false}}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
  }

Quiz/Survey Submitted​

Find below the event log object included in the request body of the notification payload sent when a quiz or survey is submitted in portal.

{
    "id": "66278",
    "eventDate": "2020-10-26T06:17:11.36",
    "ip": "136.135.169.234",
    "status": "Success",
    "subjectType": "None",
    "subjectId": 0,
    "subjectTitle": "FormSubmitted",
    "tenant": {...}, //Read more about the object here: API Reference Guide - TenantInfo Object
    "vidizmoEventId": "FormSubmitted",
    "subjectDetail": "{\"PassingCriteria\":75,\"Pages\":[{\"Name\":\"Page 1\",\"Title\":\"Page 1\",\"Visible\":true,\"Questions\":[{\"QuestionId\":\"bd8a6560-2943-1a66-3003-fb284a7f82be\",\"Name\":\"bd8a6560-2943-1a66-3003-fb284a7f82be\",\"Title\":\"What is the best feature of VIDIZMO?\",\"Type\":\"Text\",\"StartWithNewLine\":true},{\"ChoicesOrder\":\"None\",\"Choices\":[{\"Text\":\"Encryption\",\"Value\":\"435aa611-0665-a568-cc66-55b89cf51a51\",\"IsAnswer\":true},{\"Text\":\"Digital Rights Management\",\"Value\":\"970221ff-7370-6baf-74ff-ad0a50d16498\",\"IsAnswer\":true},{\"Text\":\"Media License for Limited number of Views\",\"Value\":\"f4f7a86c-4385-4f12-129c-9aedbfcba0ff\",\"IsAnswer\":true},{\"Text\":\"User Segregation\",\"Value\":\"f864befa-2e26-da7d-5659-7f5a8fd5a7c4\",\"IsAnswer\":true},{\"Text\":\"Video Player\",\"Value\":\"dae150d6-6b05-e9f5-a664-8ba2e82a90d5\"}],\"QuestionId\":\"f4eb678d-e528-526b-ffef-c00faffddb7c\",\"Name\":\"f4eb678d-e528-526b-ffef-c00faffddb7c\",\"Title\":\"What is VIDIZMO best known for?\",\"Type\":\"Checkbox\",\"StartWithNewLine\":true,\"Score\":3},{\"ChoicesOrder\":\"None\",\"Choices\":[{\"Text\":\"Encryption\",\"Value\":\"77f0c0d3-da0f-a320-6a63-6c357253064a\",\"IsAnswer\":true},{\"Text\":\"Digital Rights Management\",\"Value\":\"be4029e5-aa56-74f0-a255-26175e162d19\",\"IsAnswer\":false},{\"Text\":\"Media License for Limited number of Views\",\"Value\":\"aaf0e55a-b3f0-6df7-88da-086a003f9051\",\"IsAnswer\":false}],\"QuestionId\":\"9db3d9e3-1aac-e031-fd2c-72bc2dabcc14\",\"Name\":\"9db3d9e3-1aac-e031-fd2c-72bc2dabcc14\",\"Title\":\"What is VIDIZMO's most recent innovation?\",\"Type\":\"Radiogroup\",\"StartWithNewLine\":true,\"Score\":5},{\"ChoicesOrder\":\"None\",\"Choices\":[{\"Text\":\"Panopto\",\"Value\":\"292b719c-8d48-3f75-a017-907f0612cb21\",\"IsAnswer\":false},{\"Text\":\"Kaltura\",\"Value\":\"6661399d-f544-e42a-91fd-4e3bd4a6631a\",\"IsAnswer\":false},{\"Text\":\"No chance, VIDIZMO all the way!\",\"Value\":\"a65ec42c-d317-fccb-ac34-eb092398e2bc\",\"IsAnswer\":true}],\"QuestionId\":\"05431c89-3c84-e64d-36cb-ba014de28d14\",\"Name\":\"05431c89-3c84-e64d-36cb-ba014de28d14\",\"Title\":\"What would you choose, if not VIDIZMO?\",\"Type\":\"Radiogroup\",\"StartWithNewLine\":true,\"Score\":2}]}],\"Mode\":\"edit\",\"QuestionsOrder\":\"Initial\",\"ShowPageTitles\":false,\"ShowPrevButton\":false,\"ShowTimerPanel\":\"none\",\"ShowTimerPanelMode\":\"all\",\"Title\":\"VIDIZMO Quiz\"}",
    "user": {...}, //Read more about the object here: API Reference Guide - UserProfileInfo Object
    "isSystem": false
  }